Методы выборки параметров заданий
/services/reporting_module/api/tasks/report/export/page/by-user-id
Метод постраничной выборки записей представления параметров выполнения заданий построения отчётов по идентификатору пользователя
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| page | integer (int32) | номер страницы (начиная с 0) | да | |
| size | integer (int32) | максимальное число записей на странице | да | |
| sort | string | порядок сортировки записей (формат <поле сортировки>:<порядок сортировки>) | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/page/by-user-id
Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному идентификатору пользователя, отличного от значения NULL
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| userID | string | идентификатор пользователя | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/page/by-state
Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному статусу
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| state | string | статус задания | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/page/by-start-date
Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданной дате начала обработки задания, отличной от значения NULL
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| startDate | string (date-time) | дата начала обработки задания | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/page/by-send-notification
Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному признаку необходимости отправки нотификации пользователю о завершении выпол нения задания
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| sendNotification | boolean | признак необходимости отправки нотификации пользователю о завершении выполнения задания | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/page/by-send-notification-and-user-id
Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному признаку необходимости отправки нотификации пользователю о завершении выполнения задания и заданному идентификатору пользователя, отличного от значения NULL
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| sendNotification | boolean | признак необходимости отправки нотификации пользователю о завершении выполнения задания | нет | |
| userID | string | идентификатор пользователя | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/page/by-send-notification-and-null-user-id
Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному признаку необходимости отправки нотификации пользователю о завершении выполнения задания и идентификатору пользователя, значение которого равно NULL
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| sendNotification | boolean | признак необходимости отправки нотификации пользователю о завершении выполнения задания | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/page/by-null-user-id
Метод постраничной выборки записей таблицы хранения параметров выполнения задания по идентификатору пользователя, значение которого равно NULL
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| page | integer (int32) | н омер страницы (начиная с 0) | да | |
| size | integer (int32) | максимальное число записей на странице | да | |
| sort | string | порядок сортировки записей (формат <поле сортировки>:<порядок сортировки>) | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/page/by-null-start-date
Метод постраничной выборки записей таблицы хранения параметров выполнения задания по дате начала обработки задания, значение которой равно NULL
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| page | integer (int32) | номер страницы (начиная с 0) | да | |
| size | integer (int32) | максимальное число записей на странице | да | |
| sort | string | порядок сортировки записей (формат <поле сортировки>:<порядок сортировки>) | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/page/by-null-completion-date
Метод постраничной выборки записей таблицы хранения параметров выполнения задания по дате завершения обработки задания, значение которой равно NULL
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| page | integer (int32) | номер страницы (начиная с 0) | да | |
| size | integer (int32) | максимальное число записей на странице | да | |
| sort | string | порядок сортировки записей (формат <поле сортировки>:<порядок сортировки>) | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/page/by-kind
Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному типу
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| kind | string | вид (тип) задания | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/page/by-completion-date
Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданной дате завершения обработки задания, отличной от значения NULL
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| completionDate | string (date-time) | дата завершения обработки задания | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/page/by-assignment-date
Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданной дате поступления задания
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| assignmentDate | string (date-time) | дата поступления задания | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/by-task-id
Метод выборки записи таблицы хранения параметров выполнения задания по заданному идентификатору задания
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| taskID | string | идентификатор задания | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/tasks/by-id
Метод выборки записи таблицы хранения параметров выполнения задания по заданному идентификатору
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int64) | идентификатор | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |